<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="OSCConnection,it.h_umus.osc.OSCConnection,sendOSCPacket" name="keywords">
<title>it.h_umus.osc.OSCConnection</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'OSCConnection - API Documentation';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?it/h_umus/osc/OSCConnection.html&amp;it/h_umus/osc/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;OSCConnection</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class OSCConnection"); titleBar_setSubNav(false,false,false,false,true,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">it.h_umus.osc</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class OSCConnection</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">OSCConnection <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.net.XMLSocket</td>
</tr>
</table>
<p></p>
  The OSCConnection object allows "virtual" OSC communication. It makes use
  of the Flosc gateway server that translates UDP/OSC packets into TCP/OSC XML-like
  packets as defined by the Flosc DTD.
  
  <p>The OSCConnection object extends an XMLSocket connection, communicating with 
  Flosc server in OSC-XML-Encoded, receiving and sending data. The two main events defined 
  by the OSCConnectionEvent allow knowing when an OSC packet is recieved and  implements 
  sending methods for just OSCMessages</p>
  
  <p><p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/p/flosc" target="mm_external">http://code.google.com/p/flosc</a>
<br>
<a href="http://opensoundcontrol.org" target="mm_external">http://opensoundcontrol.org</a>
<br>flash.net.XMLSocket<br>
<a href="../osc/OSCConnectionEvent.html" target="">it.h_umus.osc.OSCConnectionEvent</a>
</div>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#OSCConnection()">OSCConnection</a>(host:String = null, port:int = 0)</div>
<div class="summaryTableDescription">
   Creates a new OSCConnection.</div>
</td><td class="summaryTableOwnerCol">OSCConnection</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#sendOSCPacket()">sendOSCPacket</a>(outPacket:<a href="OSCPacket.html">OSCPacket</a>):void</div>
<div class="summaryTableDescription">
   Converts the OSCPacket into and XML and sends it to the Flosc server.</div>
</td><td class="summaryTableOwnerCol">OSCConnection</td>
</tr>
</table>
</div>
<a name="eventSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Events</div>
<table id="summaryTableEvent" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Event</th><th>Summary</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:OSCPacketIn">OSCPacketIn</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Dispatched when an OSC packet incomes
  
  </td><td class="summaryTableOwnerCol">OSCConnection</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#event:OSCPacketOut">OSCPacketOut</a>
</div>
</td><td class="summaryTableDescription summaryTableCol">
  Dispatched when an OSC packet outgoes
  
  </td><td class="summaryTableOwnerCol">OSCConnection</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="OSCConnection()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">OSCConnection</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function OSCConnection(host:String = null, port:int = 0)</code><p>
   Creates a new OSCConnection. The OSCConnection object is not initially 
   connected to any server. You must call the OSCConnection.connect() 
   method to connect the object to a server.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">host</span>:String</code> (default = <code>null</code>)<code></code> &mdash; A fully qualified DNS domain name or an IP address in the 
   form aaa.bbb.ccc.ddd. You can also specify null to connect to the host 
   server on which the SWF file resides. If the SWF file issuing this call 
   is running in a web browser, host must be in the same domain as the SWF file.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">port</span>:int</code> (default = <code>0</code>)<code></code> &mdash; The TCP port number on the host used to establish a 
   connection. The port number must be 1024 or greater, unless a policy 
   file is being used.
   
   </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">flash.net.XMLSocket.connect</div>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="sendOSCPacket()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">sendOSCPacket</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function sendOSCPacket(outPacket:<a href="OSCPacket.html">OSCPacket</a>):void</code><p>
   Converts the OSCPacket into and XML and sends it to the Flosc server.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">outPacket</span>:<a href="OSCPacket.html">OSCPacket</a></code> &mdash;   
   Build and send XMLDocument-encoded OSC
   </td>
</tr>
</table>
</div>
<div class="detailSectionHeader">Event detail</div>
<a name="event:OSCPacketIn"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">OSCPacketIn</td><td class="detailHeaderType">event&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="../osc/OSCConnectionEvent.html"><code>it.h_umus.osc.OSCConnectionEvent</code></a>
<br>
<span class="label">OSCConnectionEvent.type property = </span><a href="../osc/OSCConnectionEvent.html#OSC_PACKET_IN"><code>it.h_umus.osc.OSCConnectionEvent.OSC_PACKET_IN</code></a>
<br><p>
  Dispatched when an OSC packet incomes
  
  </p><p>
   The OSCConnectionEvent.OSC_PACKET_IN constant defines the value of the 
   <code>type</code> property of the event object 
   for a <code>OSCPacketIn</code> event.
   
    </p></div>
<a name="event:OSCPacketOut"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">OSCPacketOut</td><td class="detailHeaderType">event&nbsp;</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<span class="label">Event object type: </span><a href="../osc/OSCConnectionEvent.html"><code>it.h_umus.osc.OSCConnectionEvent</code></a>
<br>
<span class="label">OSCConnectionEvent.type property = </span><a href="../osc/OSCConnectionEvent.html#OSC_PACKET_OUT"><code>it.h_umus.osc.OSCConnectionEvent.OSC_PACKET_OUT</code></a>
<br><p>
  Dispatched when an OSC packet outgoes
  
  </p><p>
   The OSCConnectionEvent.OSC_PACKET_OUT constant defines the value of the 
   <code>type</code> property of the event object 
   for a <code>OSCPacketOut</code> event.
   
   </p></div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
